Expose svelte2tsx component documentation #1346
Conversation
Tymek
force-pushed
the
expose-parsed-docs
branch
4 times, most recently
from
ae2b13f to
7bb4385
Compare
packages/svelte2tsx/index.d.ts
Outdated
| componentDocumentation: string; | ||
| slots: Map<string, Map<string, string>>; | ||
| generics: { | ||
| definitions: string[]; |
There was a problem hiding this comment.
The types say these are strings, but that's not true from the implementation (besides it's definition in the implementation). In the implementation it's just one string fitting the use case which is producing correct code, not something for use later.
|
Most fitting format will probably be similar if not identical to what sveld is using. ParsedComponent interface in sveld/src/ComponentParser.ts#L98-L106 With this change using other parsers like sveld will not be necessary to output slots, generics etc. I get it if this use case is better left for another package. |
Tymek
force-pushed
the
expose-parsed-docs
branch
from
7bb4385 to
4ad7631
Compare
|
@Tymek I think it would also be great to add examples on how to use it. Not neccessarily needed in this PR, but for the general public it still looks quiet abstract. |
No currently available tool is able to generate complete component documentation from svelte file. There are many attempts listed here sveltejs/kit#1979 (comment). With this change it will be possible to access documentation of component and use
svelte2tsxas a docgen tool.